home *** CD-ROM | disk | FTP | other *** search
/ Aminet 5 / Aminet 5 - March 1995.iso / Aminet / util / misc / Publican.lha / Publican / Publican.doc < prev    next >
Text File  |  1994-10-01  |  4KB  |  129 lines
  1.             
  2.             Publican documentation
  3.             ©1994 Lee Kindness.
  4.                 
  5. INTRODUCTION
  6. ============
  7.  
  8.     Publican is a public screen support utility. It allows you to set 
  9. the default public screen, set global public screen behaviour flags and
  10. obtain the name of the frontmost public screen (and write it to StdOut
  11. or a local/global variable).
  12.  
  13. PUBLICAN REQUIRES WORKBENCH 2 OR HIGHER TO WORK DUE TO PUBLIC SCREENS ONLY 
  14. EXISTING WITH WORKBENCH 2 AND HIGHER.
  15.  
  16. USAGE
  17. =====
  18.  
  19. FROM THE SHELL:
  20.  
  21.     Publican's template is as follows:
  22.     
  23. P=POPPUBSCREEN/S,S=SHANGHAI/S,L=LIST/S,VAR=VARIABLE/K,GLOBAL/S,GUI/S,
  24. DPS=PUBSCREEN=PUBSCR/K/F:
  25.  
  26. This translates to 
  27.  
  28. POPPUBSCREEN : toggle the current setting of the global POPPUBSCREEN 
  29.     flag. When this flag is set screens will be poped to the front
  30.     when windows open on them. Set by "POPPUBSCREEN" or "P".
  31.     
  32. SHANGHAI : toggle the current setting of the global SHANGHAI flag. When
  33.     this is set all windows that do not specify a screen to open on
  34.     will open on the default public screen. Set by "SHANGHAI" or "S". 
  35.     
  36. LIST : displays current system settings. Will show all public screens 
  37.     available, the front public screen, current state of SHANGHAI 
  38.     and POPPUBSCREEN flags and the name of the default public screen. 
  39.     Set by "LIST" or "L".
  40.  
  41. VARIABLE : will write the frontmost public screen to the specified 
  42.     environment variable. Set by "VARIABLE" or "VAR".
  43.     
  44. GLOBAL : If this is specified then the variable written by the VARIABLE
  45.         option will be a global variable. Set by "GLOBAL"
  46.     
  47. PUBSCR : set the default public screen. All text specified after this 
  48.     argument will be treated as the screen name. Note that screen 
  49.     names are case sensitive and that a list of the current available
  50.     public screens can be obtained using the LIST option. Set by
  51.     "PUBSCR = public screen name", "DPS public screen name"
  52.     or "PUBSCREEN = public screen name". The name of public screens
  53.     can normally be obtained from the program that opened the screen's
  54.     documentation.
  55.     
  56. If no arguments are given then the name of the front public screen will
  57. be printed out. This behaviour is similar to GetPubName (© Michael 
  58. Hohmann). This is useful for ` (back tick) use. If use use:
  59.  
  60.     PUBSCREEN=`Publican`
  61.     
  62. as a tooltype for a application then that program will open its window 
  63. on the frontmost public screen.
  64.  
  65. FROM WORKBENCH:
  66.  
  67.     When launched from Workbench Publican opens a window. This 
  68. window contains a list of all available public screens. Selecting a 
  69. screen in this list will make it the default public screen.
  70.  
  71.     Two checkmark gadgets below the listview show the current setting
  72. of the SHANGHAI and POPPUBSCREEN flags. Hitting these gadgets will alter
  73. the status of the flags. 
  74.  
  75. CONTACT
  76. =======
  77.  
  78.     You can contact me at:
  79.     
  80.     8 Craigmarn Road
  81.     Old Portlethen Village
  82.     ABERDEEN
  83.     AB1 4QR
  84.     SCOTLAND
  85.     
  86.     If you find Publican useful then let me know. Any gifts, cash and
  87. even bug reports are greatly appreciated ¿-) If you want the current 
  88. version of Publican (and a wad more progs) then send £3 (or equivalent of 
  89. £5 plus) to me.
  90.  
  91.     LSK _\\//
  92.     
  93. HISTORY
  94. =======
  95.  
  96. (Complied using Highspeed Pascal on an A1200 with a 68030, MMU, 2+4MB RAM)
  97.  
  98.     1.0    : 29.06.94.
  99.         - Initial version.
  100.         
  101.     1.0a    : 14.07.94.
  102.         - support only change.
  103.         - Added CBM installer script.
  104.         
  105.     1.1    : 18.07.94.
  106.         - Added support for global/local variables.
  107.         
  108.     1.2    : 05.09.94.
  109.         - Fixed Enforcer hits.
  110.         
  111.     1.3    : 23.09.94
  112.         - RMB now iconifies window. :-oooh
  113.         
  114.     1.4    : 26.09.94
  115.         - Added GUI switch so that the intuition interface can
  116.           be used from the CLI.
  117.         - Added DPS and PUBSCREEN shortcuts for PUBSCR argument.
  118.         - Front public scrren name now shown when LIST switch is
  119.           used.
  120.           
  121.     1.5    : 27.09.94
  122.         - "^-Update_^" gadget removed, window now updates every 2
  123.           seconds.
  124.           
  125.     1.6    : 01.10.94
  126.         - Shell arguments changed. "GLOBAL/K" and "LOCAL/K" removed,
  127.           replaced by the normal "VARIABLE/K" and "GLOBAL/S".
  128.         
  129. -EOF